package com.bicon.botu.core.base.common.utils;

import redis.clients.jedis.Jedis;

import java.util.Collections;

/**
 * 分布式锁
 *
 * @author 张露晨
 * @date 2017/12/6 15:25
 */
public class RedisTool {

    /**
     * 加锁成功标识
     */
    private static final String LOCK_SUCCESS = "OK";
    /**
     * 当key不存在时，我们进行set操作；若key已经存在，则不做任何操作。
     * 可以保证如果已有key存在，则函数不会调用成功，也就是只有一个客户端能持有锁，满足互斥性。
     */
    private static final String SET_IF_NOT_EXIST = "NX";
    /**
     * 这个参数我们传的是PX，意思是我们要给这个key加一个过期的设置，具体时间由第五个参数决定。
     * 即使锁的持有者后续发生崩溃而没有解锁，锁也会因为到了过期时间而自动解锁（即key被删除），不会发生死锁。
     */
    private static final String SET_WITH_EXPIRE_TIME = "PX";
    /**
     * 解锁程功标识
     */
    private static final Long RELEASE_SUCCESS = 1L;


    /**
     * 尝试获取分布式锁
     *
     * @param jedis      Redis客户端
     * @param lockKey    锁（使用key来当锁，因为key是唯一的）
     * @param requestId  请求标识（代表加锁的客户端请求标识，那么在客户端在解锁的时候就可以进行校验是否是同一个客户端）
     * @param expireTime 超期时间
     * @return 是否获取成功
     */
    public static boolean tryGetDistributedLock(Jedis jedis, String lockKey, String requestId, int expireTime) {

        /**
         * 加锁
         */
        String result = jedis.set(lockKey, requestId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);

        if (LOCK_SUCCESS.equals(result)) {
            return true;
        }
        return false;

    }


    /**
     * 释放分布式锁
     *
     * @param jedis     Redis客户端
     * @param lockKey   锁
     * @param requestId 请求标识
     * @return 是否释放成功
     */
    public static boolean releaseDistributedLock(Jedis jedis, String lockKey, String requestId) {

        /**
         * Lua脚本代码
         * 功能：获取锁对应的value值，检查是否与requestId相等，如果相等则删除锁（解锁）。
         * 原因：确保操作是原子性的。eval命令执行Lua代码的时候，Lua代码将被当成一个命令去执行，并且直到eval命令执行完成，Redis才会执行其他命令
         */
        String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";

        /**
         * 解锁
         */
        Object result = jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(requestId));

        if (RELEASE_SUCCESS.equals(result)) {
            return true;
        }
        return false;

    }
}
